Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Bugfixes for EOF, whitespace, and prettier checks. #120

Merged
merged 1 commit into from
Sep 2, 2024
Merged

Bugfixes for EOF, whitespace, and prettier checks. #120

merged 1 commit into from
Sep 2, 2024

Conversation

pboulos
Copy link
Contributor

@pboulos pboulos commented Aug 7, 2024 •
edited
Loading

PR Checklist

  • A description of the changes is added to the description of this PR.
  • If there is a related issue, make sure it is linked to this PR.

Description of changes

When running CI, we observe the following errors due to linting.

🚀 Checking Poetry lock file consistency with 'pyproject.toml': Running poetry lock --check
All set!
🚀 Linting code: Running pre-commit
[INFO] Initializing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Initializing environment for https://github.com/astral-sh/ruff-pre-commit.
[INFO] Initializing environment for https://github.com/pre-commit/mirrors-prettier.
[INFO] Initializing environment for https://github.com/pre-commit/mirrors-prettier:[email protected].
[INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/astral-sh/ruff-pre-commit.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
[INFO] Installing environment for https://github.com/pre-commit/mirrors-prettier.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
check for case conflicts.................................................Passed
check for merge conflicts................................................Passed
check toml...............................................................Passed
check yaml...............................................................Passed
fix end of files.........................................................Failed
- hook id: end-of-file-fixer
- exit code: 1
- files were modified by this hook

Fixing LICENSE

trim trailing whitespace.................................................Failed
- hook id: trailing-whitespace
- exit code: 1
- files were modified by this hook

Fixing .github/workflows/on-release-main.yml

ruff.....................................................................Passed
ruff-format..............................................................Passed
prettier.................................................................Failed
- hook id: prettier
- files were modified by this hook

README.md
.github/actions/setup-poetry-env/action.yml
.github/workflows/main.yml
.github/workflows/on-release-main.yml
mkdocs.yml

make: *** [Makefile:13: check] Error 1
Error: Process completed with exit code 2.

This PR applies some formatting changes across the repo such that these tests are now passed in the initial commit. This appears to be related to #96 and #97.

Changes include:

  • Reformatting the extensions item in {{cookiecutter.project_name}}/.devcontainer/devcontainer.json to be on a single line.
  • Un-indenting lines 5 through 8 in {{cookiecutter.project_name}}/.github/actions/setup-poetry-env/action.yml.
  • Removing a newline on line 51 in {{cookiecutter.project_name}}/.github/workflows/main.yml.
  • Jinja templating changes for lstrip and trim blocks in {{cookiecutter.project_name}}/.github/workflows/on-release-main.yml.
  • Jinja templating changes for lstrip and trim blocks in {{cookiecutter.project_name}}/README.md.
  • Un-indenting in {{cookiecutter.project_name}}/mkdocs.yml.

These changes should not change any user behaviour apart from allowing the CI to pass first time without any user modification.

@pboulos
Copy link
Contributor Author

pboulos commented Aug 24, 2024

@fpgmaas I wanted to ask if you could take a look at this. They've been errors that I've been encountering while using this template that I've needed to manually fix before using it every time; I thought it would be useful to make the PR for others to benefit from.

fpgmaas
fpgmaas reviewed Aug 25, 2024
View reviewed changes
pyproject.toml Outdated Show resolved Hide resolved
@fpgmaas
Copy link
Owner

fpgmaas commented Aug 25, 2024

@fpgmaas I wanted to ask if you could take a look at this. They've been errors that I've been encountering while using this template that I've needed to manually fix before using it every time; I thought it would be useful to make the PR for others to benefit from.

hanks for the contribution, and sorry for the late response! I was on holiday the past three weeks. I left one small comment; I'm happy to merge the PR after that is processed.

@fpgmaas fpgmaas merged commit c9d86d0 into fpgmaas:main Sep 2, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fpgmaas fpgmaas fpgmaas left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@pboulos @fpgmaas